<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>Plurious Framework » \framework\library\access_control\User</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Plurious Framework</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Namespaces</a></li>
<li><a href="../namespaces/framework.html"><i class="icon-th"></i> framework</a></li>
<li><a href="../namespaces/global.html"><i class="icon-th"></i> global</a></li>
<li><a href="../namespaces/plurious.html"><i class="icon-th"></i> plurious</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">439</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul><li>todo 
                <span class="label label-info">82</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public inherited"><a href="#__call" title="__call :: Specifically used to check if a user has a specific role"><span class="description">Specifically used to check if a user has a specific role</span><pre>__call()</pre></a></li>
<li class="method public "><a href="#__construct" title="__construct :: Constructor"><span class="description">Constructor</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#getContexts" title="getContexts :: Returns the contexts this user can log in to using a single
set of credentials"><span class="description">Returns the contexts this user can log in to using a single
set of credentials</span><pre>getContexts()</pre></a></li>
<li class="method public "><a href="#getEmail" title="getEmail :: Returns the user's e-mail address"><span class="description">Returns the user's e-mail address</span><pre>getEmail()</pre></a></li>
<li class="method public "><a href="#getExtended" title="getExtended :: Returns any data stored in the extended data field for this user"><span class="description">Returns any data stored in the extended data field for this user</span><pre>getExtended()</pre></a></li>
<li class="method public "><a href="#getId" title="getId :: Returns the user's ID"><span class="description">Returns the user's ID</span><pre>getId()</pre></a></li>
<li class="method public "><a href="#getLastLogin" title="getLastLogin :: Returns the last time the user logged in"><span class="description">Returns the last time the user logged in</span><pre>getLastLogin()</pre></a></li>
<li class="method public inherited"><a href="#getLastlogin" title="getLastlogin :: "><span class="description">getLastlogin()
        </span><pre>getLastlogin()</pre></a></li>
<li class="method public "><a href="#getNicename" title="getNicename :: Returns the Nice Name of the user"><span class="description">Returns the Nice Name of the user</span><pre>getNicename()</pre></a></li>
<li class="method public "><a href="#getRoles" title="getRoles :: Returns the roles for all contexts set for this user"><span class="description">Returns the roles for all contexts set for this user</span><pre>getRoles()</pre></a></li>
<li class="method public "><a href="#getSeed" title="getSeed :: A convenience method for auth getSeed()"><span class="description">A convenience method for auth getSeed()</span><pre>getSeed()</pre></a></li>
<li class="method public "><a href="#getUserName" title="getUserName :: Returns the user's usrname"><span class="description">Returns the user's usrname</span><pre>getUserName()</pre></a></li>
<li class="method public "><a href="#isActive" title="isActive :: Answers: Is this user account active?"><span class="description">Answers: Is this user account active?</span><pre>isActive()</pre></a></li>
<li class="method public "><a href="#isAdmin" title="isAdmin :: Determine if user is a site administrator (has a role == admin)"><span class="description">Determine if user is a site administrator (has a role == admin)</span><pre>isAdmin()</pre></a></li>
<li class="method public "><a href="#isCustomer" title="isCustomer :: Determine if user is a customer (has a role == customer)"><span class="description">Determine if user is a customer (has a role == customer)</span><pre>isCustomer()</pre></a></li>
<li class="method public "><a href="#isEditor" title="isEditor :: Determine if user is an editor (has a role == editor)"><span class="description">Determine if user is an editor (has a role == editor)</span><pre>isEditor()</pre></a></li>
<li class="method public "><a href="#isLocked" title="isLocked :: Answers: Is this user account locked?"><span class="description">Answers: Is this user account locked?</span><pre>isLocked()</pre></a></li>
<li class="method public "><a href="#isLoggedIn" title="isLoggedIn :: Convenience method for auth isAuthenticated()"><span class="description">Convenience method for auth isAuthenticated()</span><pre>isLoggedIn()</pre></a></li>
<li class="method public "><a href="#isMember" title="isMember :: Determine if user is a site member (has a role == member)"><span class="description">Determine if user is a site member (has a role == member)</span><pre>isMember()</pre></a></li>
<li class="method public "><a href="#login" title="login :: The preverbial log in method"><span class="description">The preverbial log in method</span><pre>login()</pre></a></li>
<li class="method public "><a href="#logout" title="logout :: Convenience method for requesting a log out"><span class="description">Convenience method for requesting a log out</span><pre>logout()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="nav-header protected">» Protected</li>
<li class="property protected "><a href="#%24auth" title="$auth :: Makes the Auth object available for use"><span class="description">Makes the Auth object available for use</span><pre>$auth</pre></a></li>
<li class="property protected "><a href="#%24config" title="$config :: Makes the Config object available for use"><span class="description">Makes the Config object available for use</span><pre>$config</pre></a></li>
<li class="property protected "><a href="#%24contexts" title="$contexts :: User data: contexts this user is authorized to log in to"><span class="description">User data: contexts this user is authorized to log in to</span><pre>$contexts</pre></a></li>
<li class="property protected "><a href="#%24document" title="$document :: Makes the Document object available for use"><span class="description">Makes the Document object available for use</span><pre>$document</pre></a></li>
<li class="property protected "><a href="#%24email" title="$email :: User data: email"><span class="description">User data: email</span><pre>$email</pre></a></li>
<li class="property protected "><a href="#%24extended" title="$extended :: User data: serialized extended user data"><span class="description">User data: serialized extended user data</span><pre>$extended</pre></a></li>
<li class="property protected "><a href="#%24id" title="$id :: User data: id"><span class="description">User data: id</span><pre>$id</pre></a></li>
<li class="property protected "><a href="#%24isActive" title="$isActive :: User data: Boolean - whether the user's account is active or not"><span class="description">User data: Boolean - whether the user's account is active or not</span><pre>$isActive</pre></a></li>
<li class="property protected "><a href="#%24isLocked" title="$isLocked :: User data: Boolean - whether the user is locked out of their account"><span class="description">User data: Boolean - whether the user is locked out of their account</span><pre>$isLocked</pre></a></li>
<li class="property protected "><a href="#%24language" title="$language :: Makes the Language object available for use"><span class="description">Makes the Language object available for use</span><pre>$language</pre></a></li>
<li class="property protected "><a href="#%24lastlogin" title="$lastlogin :: User data: lastlogin"><span class="description">User data: lastlogin</span><pre>$lastlogin</pre></a></li>
<li class="property protected "><a href="#%24nicename" title="$nicename :: User data: nicename"><span class="description">User data: nicename</span><pre>$nicename</pre></a></li>
<li class="property protected "><a href="#%24request" title="$request :: Makes the Request object available for use"><span class="description">Makes the Request object available for use</span><pre>$request</pre></a></li>
<li class="property protected "><a href="#%24roles" title="$roles :: User data: roles this user has on a per context basis"><span class="description">User data: roles this user has on a per context basis</span><pre>$roles</pre></a></li>
<li class="property protected "><a href="#%24session" title="$session :: Makes the Session object available for use"><span class="description">Makes the Session object available for use</span><pre>$session</pre></a></li>
<li class="property protected "><a href="#%24username" title="$username :: User data: username"><span class="description">User data: username</span><pre>$username</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5Cframework%5Clibrary%5Caccess_control%5CUser" id="\framework\library\access_control\User"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/framework.html">framework</a></li>
<span class="divider">\</span><li><a href="../namespaces/framework.library.html">library</a></li>
<span class="divider">\</span><li><a href="../namespaces/framework.library.access_control.html">access_control</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/framework.library.access_control.User.html">User</a>
</li>
</ul>
<div href="../classes/framework.library.access_control.User.html" class="element class">
<p class="short_description">User Class</p>
<div class="details">
<p class="long_description"><p>Authentication and Authorization for Plurious</p></p>
<table class="table table-bordered">
<tr>
<th>author</th>
<td><a href="mailto:randy@plurious.com">Randy Casburn</a></td>
</tr>
<tr>
<th>copyright</th>
<td>Copyright Plurious Software, all rights reserved</td>
</tr>
<tr>
<th>license</th>
<td><a href="http://opensource.org/licenses/MIT">MIT</a></td>
</tr>
<tr>
<th>license</th>
<td><a href="http://www.opensource.org/licenses/mit-license.html">http://www.opensource.org/licenses/mit-license.html</a></td>
</tr>
<tr>
<th>link</th>
<td><a href="http://plurious.com/framework/documentation/classes/Front.html">http://plurious.com/framework/documentation/classes/Front.html</a></td>
</tr>
<tr>
<th>version</th>
<td>2.1</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\Front</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\library\language</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\library\access_control\Role</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\library\interfaces\User_Interface</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\library\authentication\Auth</td>
</tr>
<tr>
<th>used_by</th>
<td>\framework\Front</td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__call" id="__call"></a><div class="element clickable method public __call" data-toggle="collapse" data-target=".__call .collapse">
<h2>Specifically used to check if a user has a specific role</h2>
<pre>__call(string $name, $arguments) : boolean</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>GIVEN: role names of member, editor, customer, admin
USE: $user->isMember(); $user->isEditor(); $user->isCustomer(); $user->isAdmin();</p>

<p>The magic method is used since we cannot determine the names of the
roles that may exist in the system.  So this method overloads those
possible names.</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\library\access_control\Role::__call()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$name</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$arguments</h4>
<code></code>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>boolean</code>To indicate whether a role is associated with this user</div>
</div></div>
</div>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Constructor</h2>
<pre>__construct() : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Loads up config variables into class variables</p></p>
<table class="table table-bordered"><tr>
<th>access</th>
<td>public</td>
</tr></table>
</div></div>
</div>
<a name="getContexts" id="getContexts"></a><div class="element clickable method public getContexts" data-toggle="collapse" data-target=".getContexts .collapse">
<h2>Returns the contexts this user can log in to using a single
set of credentials</h2>
<pre>getContexts() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>Array of contexts associated with this user</div>
</div></div>
</div>
<a name="getEmail" id="getEmail"></a><div class="element clickable method public getEmail" data-toggle="collapse" data-target=".getEmail .collapse">
<h2>Returns the user's e-mail address</h2>
<pre>getEmail() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>The user's e-mail address</div>
</div></div>
</div>
<a name="getExtended" id="getExtended"></a><div class="element clickable method public getExtended" data-toggle="collapse" data-target=".getExtended .collapse">
<h2>Returns any data stored in the extended data field for this user</h2>
<pre>getExtended() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>This column was added to the database for ease of use purposes. When
There is only one or two data points to collect beyond those listed
already, it is not effiecient to build CODD Normalization!</p></p>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>Associative array of extended user data</div>
</div></div>
</div>
<a name="getId" id="getId"></a><div class="element clickable method public getId" data-toggle="collapse" data-target=".getId .collapse">
<h2>Returns the user's ID</h2>
<pre>getId() : int</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>int</code>The user's ID</div>
</div></div>
</div>
<a name="getLastLogin" id="getLastLogin"></a><div class="element clickable method public getLastLogin" data-toggle="collapse" data-target=".getLastLogin .collapse">
<h2>Returns the last time the user logged in</h2>
<pre>getLastLogin() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>The last time the user logged in</div>
</div></div>
</div>
<a name="getLastlogin" id="getLastlogin"></a><div class="element clickable method public getLastlogin" data-toggle="collapse" data-target=".getLastlogin .collapse">
<h2>getLastlogin()
        </h2>
<pre>getLastlogin() </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\library\interfaces\User_Interface::getLastlogin()</td>
</tr></table>
</div></div>
</div>
<a name="getNicename" id="getNicename"></a><div class="element clickable method public getNicename" data-toggle="collapse" data-target=".getNicename .collapse">
<h2>Returns the Nice Name of the user</h2>
<pre>getNicename() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>This is used as an alternative to the username for greeting purposes and
other personalization use cases.</p></p>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>The user's Nice Name</div>
</div></div>
</div>
<a name="getRoles" id="getRoles"></a><div class="element clickable method public getRoles" data-toggle="collapse" data-target=".getRoles .collapse">
<h2>Returns the roles for all contexts set for this user</h2>
<pre>getRoles() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>Associative array of contexts with associated user roles</div>
</div></div>
</div>
<a name="getSeed" id="getSeed"></a><div class="element clickable method public getSeed" data-toggle="collapse" data-target=".getSeed .collapse">
<h2>A convenience method for auth getSeed()</h2>
<pre>getSeed() : int</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>The seed (nonce) used throughout the authentication process is needed</p></p>
<h3>Returns</h3>
<div class="subelement response">
<code>int</code>The current seed</div>
</div></div>
</div>
<a name="getUserName" id="getUserName"></a><div class="element clickable method public getUserName" data-toggle="collapse" data-target=".getUserName .collapse">
<h2>Returns the user's usrname</h2>
<pre>getUserName() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>The username of the current user</div>
</div></div>
</div>
<a name="isActive" id="isActive"></a><div class="element clickable method public isActive" data-toggle="collapse" data-target=".isActive .collapse">
<h2>Answers: Is this user account active?</h2>
<pre>isActive() : boolean</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>boolean</code>True=Active (I'll let you guess about false)</div>
</div></div>
</div>
<a name="isAdmin" id="isAdmin"></a><div class="element clickable method public isAdmin" data-toggle="collapse" data-target=".isAdmin .collapse">
<h2>Determine if user is a site administrator (has a role == admin)</h2>
<pre>isAdmin() : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>magic</th>
<td></td>
</tr>
<tr>
<th>method</th>
<td>Determine if user is a site administrator (has a role == admin)</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response"><code>bool</code></div>
</div></div>
</div>
<a name="isCustomer" id="isCustomer"></a><div class="element clickable method public isCustomer" data-toggle="collapse" data-target=".isCustomer .collapse">
<h2>Determine if user is a customer (has a role == customer)</h2>
<pre>isCustomer() : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>magic</th>
<td></td>
</tr>
<tr>
<th>method</th>
<td>Determine if user is a customer (has a role == customer)</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response"><code>bool</code></div>
</div></div>
</div>
<a name="isEditor" id="isEditor"></a><div class="element clickable method public isEditor" data-toggle="collapse" data-target=".isEditor .collapse">
<h2>Determine if user is an editor (has a role == editor)</h2>
<pre>isEditor() : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>magic</th>
<td></td>
</tr>
<tr>
<th>method</th>
<td>Determine if user is an editor (has a role == editor)</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response"><code>bool</code></div>
</div></div>
</div>
<a name="isLocked" id="isLocked"></a><div class="element clickable method public isLocked" data-toggle="collapse" data-target=".isLocked .collapse">
<h2>Answers: Is this user account locked?</h2>
<pre>isLocked() : boolean</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>boolean</code>True=Locked (I'll let you guess about false)</div>
</div></div>
</div>
<a name="isLoggedIn" id="isLoggedIn"></a><div class="element clickable method public isLoggedIn" data-toggle="collapse" data-target=".isLoggedIn .collapse">
<h2>Convenience method for auth isAuthenticated()</h2>
<pre>isLoggedIn() : \framework\library\access_control\type</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response"><code>\framework\library\access_control\type</code></div>
</div></div>
</div>
<a name="isMember" id="isMember"></a><div class="element clickable method public isMember" data-toggle="collapse" data-target=".isMember .collapse">
<h2>Determine if user is a site member (has a role == member)</h2>
<pre>isMember() : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>magic</th>
<td></td>
</tr>
<tr>
<th>method</th>
<td>Determine if user is a site member (has a role == member)</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response"><code>bool</code></div>
</div></div>
</div>
<a name="login" id="login"></a><div class="element clickable method public login" data-toggle="collapse" data-target=".login .collapse">
<h2>The preverbial log in method</h2>
<pre>login() : \framework\library\access_control\Success</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Uses the request object to obtain cleaned form data and sends to the
authentication method for processing.  Sets the session login_message
value with result message from the lanugage object.</p></p>
<h3>Returns</h3>
<div class="subelement response">
<code>\framework\library\access_control\Success</code>or Failure mode</div>
</div></div>
</div>
<a name="logout" id="logout"></a><div class="element clickable method public logout" data-toggle="collapse" data-target=".logout .collapse">
<h2>Convenience method for requesting a log out</h2>
<pre>logout() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"><p>It's more natural for some folks to use User->logout() than Auth->logout().</p></p></div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24auth" id="$auth"> </a><div class="element clickable property protected $auth" data-toggle="collapse" data-target=".$auth .collapse">
<h2>Makes the Auth object available for use</h2>
<pre>$auth </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24config" id="$config"> </a><div class="element clickable property protected $config" data-toggle="collapse" data-target=".$config .collapse">
<h2>Makes the Config object available for use</h2>
<pre>$config </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24contexts" id="$contexts"> </a><div class="element clickable property protected $contexts" data-toggle="collapse" data-target=".$contexts .collapse">
<h2>User data: contexts this user is authorized to log in to</h2>
<pre>$contexts </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24document" id="$document"> </a><div class="element clickable property protected $document" data-toggle="collapse" data-target=".$document .collapse">
<h2>Makes the Document object available for use</h2>
<pre>$document </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24email" id="$email"> </a><div class="element clickable property protected $email" data-toggle="collapse" data-target=".$email .collapse">
<h2>User data: email</h2>
<pre>$email </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24extended" id="$extended"> </a><div class="element clickable property protected $extended" data-toggle="collapse" data-target=".$extended .collapse">
<h2>User data: serialized extended user data</h2>
<pre>$extended </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24id" id="$id"> </a><div class="element clickable property protected $id" data-toggle="collapse" data-target=".$id .collapse">
<h2>User data: id</h2>
<pre>$id </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24isActive" id="$isActive"> </a><div class="element clickable property protected $isActive" data-toggle="collapse" data-target=".$isActive .collapse">
<h2>User data: Boolean - whether the user's account is active or not</h2>
<pre>$isActive </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24isLocked" id="$isLocked"> </a><div class="element clickable property protected $isLocked" data-toggle="collapse" data-target=".$isLocked .collapse">
<h2>User data: Boolean - whether the user is locked out of their account</h2>
<pre>$isLocked </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24language" id="$language"> </a><div class="element clickable property protected $language" data-toggle="collapse" data-target=".$language .collapse">
<h2>Makes the Language object available for use</h2>
<pre>$language </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24lastlogin" id="$lastlogin"> </a><div class="element clickable property protected $lastlogin" data-toggle="collapse" data-target=".$lastlogin .collapse">
<h2>User data: lastlogin</h2>
<pre>$lastlogin </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24nicename" id="$nicename"> </a><div class="element clickable property protected $nicename" data-toggle="collapse" data-target=".$nicename .collapse">
<h2>User data: nicename</h2>
<pre>$nicename </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24request" id="$request"> </a><div class="element clickable property protected $request" data-toggle="collapse" data-target=".$request .collapse">
<h2>Makes the Request object available for use</h2>
<pre>$request </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24roles" id="$roles"> </a><div class="element clickable property protected $roles" data-toggle="collapse" data-target=".$roles .collapse">
<h2>User data: roles this user has on a per context basis</h2>
<pre>$roles </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24session" id="$session"> </a><div class="element clickable property protected $session" data-toggle="collapse" data-target=".$session .collapse">
<h2>Makes the Session object available for use</h2>
<pre>$session </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24username" id="$username"> </a><div class="element clickable property protected $username" data-toggle="collapse" data-target=".$username .collapse">
<h2>User data: username</h2>
<pre>$username </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a7</a> and<br>
            generated on 2012-07-06T18:53:43-05:00.<br></footer></div>
</div>
</body>
</html>
